Rename EntityCache to EntityStore. #5618
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I believe the job of a GraphQL cache is not simply to remember the results of past GraphQL queries, but to ingest those queries into a client-side data graph that faithfully replicates a subset of the complete data graph described by your schema. To that end, the name `EntityCache` feels slightly inaccurate, because this data structure is the source of truth for your client-side data graph, which consists of entity objects, their fields, and their references to each other, to name just a few concepts that transcend the particulars of caching GraphQL results. Instead, I think `EntityStore` more accurately reflects the first-class status of the client-side data graph, with the `InMemoryCache` as a wrapper of the `EntityStore` and a consumer of the entity objects that reside within it. If you're curious about the philosophy behind this separation of concerns, check out my talk from GraphQL Summit: https://youtu.be/n_j8QckQN5I?t=114 If you don't care about the names of these abstractions, you can rest easy knowing that this change is (in some sense) purely cosmetic.
hwillson
approved these changes
Nov 25, 2019
There was a problem hiding this comment.
I love this - using cache for both EntityCache and InMemoryCache (with one essentially wrapping the other) had the potential to confuse contributors. I definitely think this is more clear (and I care about abstractions probably way more than I should 🙂). LGTM!
benjamn
changed the base branch from
finer-grained-result-caching
to
release-3.0
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR builds on #5617, but you do not need to review those changes first.
I believe the job of a GraphQL cache is not simply to remember the results of past GraphQL queries, but to ingest those queries into a client-side data graph that faithfully replicates a subset of the complete data graph described by your schema.
To that end, the name
EntityCachefeels slightly inaccurate, because this data structure is the source of truth for your client-side data graph, which consists of entity objects, their fields, and their references to each other, to name just a few concepts that transcend the particulars of caching GraphQL results.Instead, I think
EntityStoremore accurately reflects the first-class status of the client-side data graph, with theInMemoryCacheas a wrapper of theEntityStoreand a consumer of the entity objects that reside within it.If you're curious about the philosophy behind this separation of concerns, check out my talk from GraphQL Summit.
If you don't care about the names of these abstractions, you can rest easy knowing that this change is (in some sense) purely cosmetic. ✨